Annotation

์• ๋…ธํ…Œ์ด์…˜์€ Java 5 ๋ถ€ํ„ฐ ๋“ฑ์žฅํ•œ ๊ธฐ๋Šฅ์œผ๋กœ, ์‚ฌ์ „์ ์˜๋ฏธ๋Š” โ€œ์ฃผ์„โ€์ด์ง€๋งŒ, ํด๋ž˜์Šค๋‚˜ ๋ฉ”์„œ๋“œ ๋“ฑ ํƒ€์ผ“์— ๋ผ๋ฒจ์„ ๋ถ™์—ฌ์ค€๋‹ค. ๋น„์ฆˆ๋‹ˆ์Šค ๋กœ์ง์—๋Š” ์˜ํ–ฅ์„ ์ฃผ์ง€๋Š” ์•Š์ง€๋งŒ, ํ•ด๋‹น ํƒ€์ผ“์˜ ์—ฐ๊ฒฐ ๋ฐฉ๋ฒ•์ด๋‚˜ ์†Œ์Šค ์ฝ”๋“œ์˜ ๊ตฌ์กฐ๋ฅผ ๋ณ€๊ฒฝํ•  ์ˆ˜๋„ ์žˆ๋‹ค. ์• ๋…ธํ…Œ์ด์…˜์€ ์†Œ์Šค์ฝ”๋“œ์— ๋ฉ”ํƒ€๋ฐ์ดํ„ฐ๋ฅผ ์‚ฝ์ž…ํ•˜๋Š” ๊ฒƒ์ด๊ธฐ ๋•Œ๋ฌธ์— ์ž˜ ์ด์šฉํ•˜๋ฉด ๊ตฌ๋…์„ฑ๋ฟ๋งŒ ์•„๋‹ˆ๋ผ ์ฒด๊ณ„์ ์ธ ์†Œ์Šค์ฝ”๋“œ ๊ตฌ์„ฑ์—๋„ ๋„์›€์„ ์ค€๋‹ค.

// ์• ๋…ธํ…Œ์ด์…˜ ์˜ˆ์‹œ
@Service
public class ArticleService

์ปค์Šคํ…€ Annotation

์ปค์Šคํ…€ ์• ๋…ธํ…Œ์ด์…˜์€ ๋ฉ”ํƒ€ ์• ๋…ธํ…Œ์ด์…˜์„ ์‚ฌ์šฉํ•˜์—ฌ ๋‹ค์Œ๊ณผ ๊ฐ™์€ ๊ตฌ์กฐ๋ฅผ ๊ฐ€์ง„๋‹ค.

@Target({ElementType.[์ ์šฉ๋Œ€์ƒ]})
@Retention(RetentionPolicy.[์ •๋ณด์œ ์ง€๋˜๋Š” ๋Œ€์ƒ])
public @interface [์–ด๋…ธํ…Œ์ด์…˜๋ช…] {
  public ํƒ€์ž… elementName() [default ๊ฐ’]
  ...
}
  • @Target๊ณผ @Retention ๋“ฑ๊ณผ ๊ฐ™์€ ๋ฉ”ํƒ€ ์• ๋…ธํ…Œ์ด์…˜์œผ๋กœ ์• ๋…ธํ…Œ์ด์…˜์˜ ์„ฑ์งˆ์„ ์ •์˜ํ•œ๋‹ค.

  • ์• ๋…ธํ…Œ์ด์…˜์ด ๊ฐ€์งˆ ์ˆ˜ ์žˆ๋Š” ํ•„๋“œ ํƒ€์ž…์€ enum, String, ์›์‹œํ˜•, ์›์‹œํ˜•์˜ ๋ฐฐ์—ด๋งŒ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋‹ค.

  • ๋‹ค์Œ์ฒ˜๋Ÿผ ๋‹ค๋ฅธ ์• ๋…ธํ…Œ์ด์…˜์„ ์ถ”๊ฐ€ํ•  ์ˆ˜๋„ ์žˆ๋‹ค.

    @Target({ElementType.[์ ์šฉ๋Œ€์ƒ]})
    @Retention(RetentionPolicy.[์ •๋ณด์œ ์ง€๋˜๋Š” ๋Œ€์ƒ])
    @Service
    @RequiredArgsConstructor
    public @interface [์–ด๋…ธํ…Œ์ด์…˜๋ช…]

๋ฉ”ํƒ€ ์• ๋…ธํ…Œ์ด์…˜

  • @Retention : ์• ๋…ธํ…Œ์ด์…˜์˜ ๋ผ์ดํ”„ ์‚ฌ์ดํด์„ ์ •์˜ํ•˜๋Š” ์• ๋…ธํ…Œ์ด์…˜์œผ๋กœ, ์• ๋…ธํ…Œ์ด์…˜์ด ์–ธ์ œ๊นŒ์ง€ ๋ฉ”๋ชจ๋ฆฌ ์ƒ์— ์‚ด์•„์žˆ์„ ๊ฑด์ง€ ์ •์˜
    • RetentionPolicy.SOURCE : ์ปดํŒŒ์ผ ์ „๊นŒ์ง€๋งŒ ์œ ํšจ
    • RetentionPolicy.CLASS : ์ปดํŒŒ์ผ๋Ÿฌ๊ฐ€ ํด๋ž˜์Šค๋ฅผ ์ฐธ์กฐํ•  ๋•Œ๊นŒ์ง€ ์œ ํšจ
    • RetentionPolicy.RUNTIME : ์ปดํŒŒ์ผ ์ดํ›„ ๋Ÿฐํƒ€์ž„ ๋•Œ๋„ JVM์— ์˜ํ•ด ์ฐธ์กฐ ๊ฐ€๋Šฅํ•จ
  • @Target : ์• ๋…ธํ…Œ์ด์…˜์„ ์ ์šฉํ•  ์œ„์น˜ ์„ ํƒ
    • ElementType.PACKAGE : ํŒจํ‚ค์ง€ ์„ ์–ธ
    • ElementType.TYPE : ํƒ€์ž… ์„ ์–ธ
    • ElementType.ANNOTATION_TYPE : ์–ด๋…ธํ…Œ์ด์…˜ ํƒ€์ž… ์„ ์–ธ
    • ElementType.CONSTRUCTOR : ์ƒ์„ฑ์ž ์„ ์–ธ
    • ElementType.FIELD : ๋ฉค๋ฒ„ ๋ณ€์ˆ˜ ์„ ์–ธ
    • ElementType.LOCAL_VARIABLE : ์ง€์—ญ ๋ณ€์ˆ˜ ์„ ์–ธ
    • ElementType.METHOD : ๋ฉ”์„œ๋“œ ์„ ์–ธ
    • ElementType.PARAMETER : ์ „๋‹ฌ์ธ์ž ์„ ์–ธ
    • ElementType.TYPE_PARAMETER : ์ „๋‹ฌ์ธ์ž ํƒ€์ž… ์„ ์–ธ
    • ElementType.TYPE_USE : ํƒ€์ž… ์„ ์–ธ
  • @Documented : ํ•ด๋‹น ์• ๋…ธํ…Œ์ด์…˜์ด ๋ถ™์€ ๋Œ€์ƒ์„ javadoc์— ํฌํ•จ์‹œํ‚ด
  • @Inherited : ์• ๋…ธํ…Œ์ด์…˜์˜ ์ƒ์†์„ ๊ฐ€๋Šฅํ•˜๊ฒŒ ํ•จ
  • @Repeatable : Java8๋ถ€ํ„ฐ ์ง€์›ํ•˜๋ฉฐ, ์—ฐ์†์ ์œผ๋กœ ์• ๋…ธํ…Œ์ด์…˜์„ ์„ ์–ธํ•  ์ˆ˜ ์žˆ๊ฒŒํ•จ

์†์„ฑ ์ •์˜

์• ๋…ธํ…Œ์ด์…˜์„ ์ •์˜ํ•  ๋• ๋งˆ์น˜ ์ธํ„ฐํŽ˜์ด์Šค์ฒ˜๋Ÿผ ๋‹ค์–‘ํ•œ ์†์„ฑ์„ ์ •์˜ํ•  ์ˆ˜ ์žˆ๋‹ค.

public @interface MyAnnotation {
  public String name() default "";
  public int age() default 20;
  public String value() default "";
    ...
}

์ด ์ค‘์—์„œ value๋ผ๋Š” ์ด๋ฆ„์„ ๊ฐ€์ง„ ์†์„ฑ์€ ํŠน๋ณ„ํ•œ ์†์„ฑ์œผ๋กœ, ์• ๋…ธํ…Œ์ด์…˜์„ ์‚ฌ์šฉํ•  ๋•Œ ์•„๋ฌด๋Ÿฐ ์†์„ฑ์ด๋ฆ„ ์—†์ด ํ•˜๋‚˜์˜ ๊ฐ’๋งŒ ์‚ฌ์šฉํ•˜๋ฉด ์ž๋™์œผ๋กœ value ์†์„ฑ์— ํ• ๋‹น๋œ๋‹ค.

// ์—ฌ๋Ÿฌ ์†์„ฑ์„ ๋ถ€์—ฌํ•  ๋•Œ
@MyAnnotation(name="Shin", age=20, value="this will be assigned to value")
// ํ•œ๊ฐ€์ง€ ๊ฐ’๋งŒ ๋„ฃ์œผ๋ฉด value์— ํ• ๋‹น๋œ๋‹ค.
@MyAnnotation("this will be assigned to value")

์ž๋ฐ” ๋ฆฌํ”Œ๋ž™์…˜

์–ดํ”Œ๋ฆฌ์ผ€์ด์…˜ ์‹คํ–‰์‹œ ์ปค์Šคํ…€ ์• ๋…ธํ…Œ์ด์…˜์„ ์‚ฌ์šฉํ•œ ๊ณณ๊ณผ ์ง€์ •ํ•œ ๊ฐ’๋“ค์„ ์–ป์–ด์˜ค๋ ค๋ฉด ์ž๋ฐ” ๋ฆฌํ”Œ๋ž™์…˜์„ ์‚ฌ์šฉํ•ด์•ผํ•œ๋‹ค.

Method method = MyClass.class.getMethod("doThis"); //์ž๋ฐ” ๋ฆฌํ”Œ๋ ‰์…˜ getMethod๋กœ ๋ฉ”์„œ๋“œ doThis๋ฅผ ์–ป์–ด์˜จ๋‹ค
Annotation[] annotations = method.getDeclaredAnnotations(); //๋ฉ”์„œ๋“œ์— ์„ ์–ธ๋œ ์–ด๋…ธํ…Œ์ด์…˜ ๊ฐ์ฒด๋ฅผ ์–ป์–ด์˜จ๋‹ค
 
//๋ฉ”์„œ๋“œ doThat์— ์„ ์–ธ๋œ MyAnnotation์˜ ์–ด๋…ธํ…Œ์ด์…˜ ๊ฐ์ฒด๋ฅผ ์–ป์–ด์˜จ๋‹ค
Annotation annotation = MyClass.class.getMethod("doThat").getAnnotation(MyAnnotation.class);

์ถœ์ฒ˜

https://www.nextree.co.kr/p5864/

https://jeong-pro.tistory.com/234

https://velog.io/@potato_song/Java-%EC%96%B4%EB%85%B8%ED%85%8C%EC%9D%B4%EC%85%98-%EC%BB%A4%EC%8A%A4%ED%85%80-%EC%96%B4%EB%85%B8%ED%85%8C%EC%9D%B4%EC%85%98-%EB%A7%8C%EB%93%A4%EA%B8%B0